<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>rest_client_c: RestResponse Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">rest_client_c
   &#160;<span id="projectnumber">1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structRestResponse.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">RestResponse Struct Reference<div class="ingroups"><a class="el" href="group__REST__API.html">REST Client</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>This is a standard response from REST operations.  
 <a href="structRestResponse.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="rest__client_8h_source.html">rest_client.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ga4372ccd44ab3cdeaabd3c2ab806510a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4372ccd44ab3cdeaabd3c2ab806510a3"></a>
<a class="el" href="structObject.html">Object</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga4372ccd44ab3cdeaabd3c2ab806510a3.html#ga4372ccd44ab3cdeaabd3c2ab806510a3">parent</a></td></tr>
<tr class="memdesc:ga4372ccd44ab3cdeaabd3c2ab806510a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent class's fields. <br/></td></tr>
<tr class="memitem:ga85a61f90362e9f93e702cad1032d468f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga85a61f90362e9f93e702cad1032d468f.html#ga85a61f90362e9f93e702cad1032d468f">http_code</a></td></tr>
<tr class="memdesc:ga85a61f90362e9f93e702cad1032d468f"><td class="mdescLeft">&#160;</td><td class="mdescRight">HTTP code of the last operation.  <a href="group__REST__API_ga85a61f90362e9f93e702cad1032d468f.html#ga85a61f90362e9f93e702cad1032d468f"></a><br/></td></tr>
<tr class="memitem:ga6e3399e311a316ac012548a94234037c"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga6e3399e311a316ac012548a94234037c.html#ga6e3399e311a316ac012548a94234037c">http_status</a> [<a class="el" href="group__REST__API_gadfb08e31817eba31a39cbab6810f5756.html#gadfb08e31817eba31a39cbab6810f5756">ERROR_MESSAGE_SIZE</a>]</td></tr>
<tr class="memdesc:ga6e3399e311a316ac012548a94234037c"><td class="mdescLeft">&#160;</td><td class="mdescRight">HTTP status line of the last operation.  <a href="group__REST__API_ga6e3399e311a316ac012548a94234037c.html#ga6e3399e311a316ac012548a94234037c"></a><br/></td></tr>
<tr class="memitem:ga130c895035dbbf0b5c2078850ddc6b79"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga130c895035dbbf0b5c2078850ddc6b79.html#ga130c895035dbbf0b5c2078850ddc6b79">curl_error</a></td></tr>
<tr class="memdesc:ga130c895035dbbf0b5c2078850ddc6b79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error code from libcurl.  <a href="group__REST__API_ga130c895035dbbf0b5c2078850ddc6b79.html#ga130c895035dbbf0b5c2078850ddc6b79"></a><br/></td></tr>
<tr class="memitem:ga07ffe62eff3ae6cc18ba3710d7e7de79"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga07ffe62eff3ae6cc18ba3710d7e7de79"></a>
char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga07ffe62eff3ae6cc18ba3710d7e7de79.html#ga07ffe62eff3ae6cc18ba3710d7e7de79">curl_error_message</a> [CURL_ERROR_SIZE]</td></tr>
<tr class="memdesc:ga07ffe62eff3ae6cc18ba3710d7e7de79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains a textual error message from libcurl. <br/></td></tr>
<tr class="memitem:ga573727c86da0b377b7d0bb87f69908a1"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga573727c86da0b377b7d0bb87f69908a1.html#ga573727c86da0b377b7d0bb87f69908a1">response_headers</a> [<a class="el" href="group__REST__API_gab8949645fa8d90e1722d233c6bdfc815.html#gab8949645fa8d90e1722d233c6bdfc815">MAX_HEADERS</a>]</td></tr>
<tr class="memdesc:ga573727c86da0b377b7d0bb87f69908a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Response headers parsed from the HTTP response.  <a href="group__REST__API_ga573727c86da0b377b7d0bb87f69908a1.html#ga573727c86da0b377b7d0bb87f69908a1"></a><br/></td></tr>
<tr class="memitem:ga882bbdbf00fa03923dce4899e36740b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga882bbdbf00fa03923dce4899e36740b5"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga882bbdbf00fa03923dce4899e36740b5.html#ga882bbdbf00fa03923dce4899e36740b5">response_header_count</a></td></tr>
<tr class="memdesc:ga882bbdbf00fa03923dce4899e36740b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of response headers present in the response_headers array. <br/></td></tr>
<tr class="memitem:ga4f673cbc9fd671e9e45e44286cc47028"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga4f673cbc9fd671e9e45e44286cc47028.html#ga4f673cbc9fd671e9e45e44286cc47028">content_type</a></td></tr>
<tr class="memdesc:ga4f673cbc9fd671e9e45e44286cc47028"><td class="mdescLeft">&#160;</td><td class="mdescRight">Content type of the response.  <a href="group__REST__API_ga4f673cbc9fd671e9e45e44286cc47028.html#ga4f673cbc9fd671e9e45e44286cc47028"></a><br/></td></tr>
<tr class="memitem:gaf4b21f9ce17e9d44e6049a30c887d2c2"><td class="memItemLeft" align="right" valign="top">off_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_gaf4b21f9ce17e9d44e6049a30c887d2c2.html#gaf4b21f9ce17e9d44e6049a30c887d2c2">content_length</a></td></tr>
<tr class="memdesc:gaf4b21f9ce17e9d44e6049a30c887d2c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bytes in the response.  <a href="group__REST__API_gaf4b21f9ce17e9d44e6049a30c887d2c2.html#gaf4b21f9ce17e9d44e6049a30c887d2c2"></a><br/></td></tr>
<tr class="memitem:ga383cc64782778a32743eb846031e6c5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga383cc64782778a32743eb846031e6c5e"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga383cc64782778a32743eb846031e6c5e.html#ga383cc64782778a32743eb846031e6c5e">body</a></td></tr>
<tr class="memdesc:ga383cc64782778a32743eb846031e6c5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the response body. <br/></td></tr>
<tr class="memitem:gac6ae52e6316f7819901ba5fd818f8425"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_gac6ae52e6316f7819901ba5fd818f8425.html#gac6ae52e6316f7819901ba5fd818f8425">buffer_size</a></td></tr>
<tr class="memdesc:gac6ae52e6316f7819901ba5fd818f8425"><td class="mdescLeft">&#160;</td><td class="mdescRight">If use_buffer is nonzero, this is the maximum number of bytes that can be written into the body buffer.  <a href="group__REST__API_gac6ae52e6316f7819901ba5fd818f8425.html#gac6ae52e6316f7819901ba5fd818f8425"></a><br/></td></tr>
<tr class="memitem:gae2485658ff0501edb5274641964ba31f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_gae2485658ff0501edb5274641964ba31f.html#gae2485658ff0501edb5274641964ba31f">use_buffer</a></td></tr>
<tr class="memdesc:gae2485658ff0501edb5274641964ba31f"><td class="mdescLeft">&#160;</td><td class="mdescRight">If nonzero, the user has provided us with a static buffer to fill with the response.  <a href="group__REST__API_gae2485658ff0501edb5274641964ba31f.html#gae2485658ff0501edb5274641964ba31f"></a><br/></td></tr>
<tr class="memitem:ga6955db18d63c89803e6cabf9602bd7fc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6955db18d63c89803e6cabf9602bd7fc"></a>
FILE *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__REST__API_ga6955db18d63c89803e6cabf9602bd7fc.html#ga6955db18d63c89803e6cabf9602bd7fc">file_body</a></td></tr>
<tr class="memdesc:ga6955db18d63c89803e6cabf9602bd7fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">If not-NULL, the response body will be written to this file handle instead of memory. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This is a standard response from REST operations. </p>
<p>Do not modify this object directly; instead use the RestResponse_xxx methods. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="rest__client_8h_source.html">rest_client.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structRestResponse.html">RestResponse</a></li>
    <li class="footer">Generated on Fri Oct 19 2012 13:02:48 for rest_client_c by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
  </ul>
</div>
</body>
</html>
